home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection Student Program / ADC Tools Sampler CD Disk 3 1999.iso / Documentation / Java / ZipSight / zipsight.txt < prev    next >
Encoding:
Text File  |  1999-06-02  |  7.8 KB  |  189 lines  |  [TEXT/CWIE]
  1. ========================================================================
  2. Metrowerks ZipSight HTTP Server Release Notes 
  3. ========================================================================
  4.  
  5. Version: 1.2
  6. Date:    01/27/99
  7. Author:  Pedro Larios
  8. ========================================================================
  9.  
  10. This app is an http server that allows the user to view html docs inside 
  11. a zip or jar file, preserving all the links within the docs. This is 
  12. particularly useful on the Mac where the filename limit of 31
  13. characters renders most javadoc documentation useless. However,
  14. since this application is 100% pure Java, it will (supposedly) run
  15. on any platform which has a 1.1 or later capable VM. It has been
  16. tested on Windows and Mac only.
  17.  
  18. When the application is launched, a window will come up which will
  19. have three buttons: "configure", "start", and "quit". Below the
  20. buttons are the server address and status information. 
  21.  
  22. The configure button brings up a configuration panel that allows the 
  23. user to specify the server options. The configuration panel has two
  24. tabs. The "general" tab contains the server path and port number.
  25. The "security" tab contains options to enable logging of all http
  26. transactions, as well as options to start the server automatically on 
  27. launch and to disallow remote connections.
  28.  
  29. General settings
  30. ----------------
  31. The server path points to a directory on the host machine containing
  32. the zip/jar files. All http requests the server gets will be relative
  33. to this server path. For example, if the server receives an http 
  34. request of the form: 
  35.  
  36. http://127.0.0.1/foo/bar/MyDocs.zip/index.html
  37.  
  38. the server will look for the file MyDocs.zip in the path:
  39.  
  40. server_path/foo/bar/
  41.  
  42. IMPORTANT NOTE: Although http requests that attempt to go above the 
  43. server path (i.e. those of the form "http://127.0.0.1/../../file.html") 
  44. will always be denied (the server will return a "403 Forbidden" error 
  45. message), all files inside the server path will be visible. Therefore, 
  46. be careful not to set the server path to a directory containing 
  47. files that you do not wish to make available to the network.
  48.  
  49. The server port is the port number on which the server listens for
  50. connections. By default, this is set to port 80 (the well-known
  51. port number for WWW-HTTP) but can be changed to any valid port number.
  52.  
  53. Security settings
  54. -----------------
  55. The check box marked "Keep a log of server activity" determines whether 
  56. or not ZipSight will keep a log of all server transactions. This log will 
  57. be saved in a text file called "ZipSight.log" which will be created in 
  58. the same folder as the one the ZipSight application resides in.
  59.  
  60. The check box marked "Start server on launch" determines whether or not 
  61. the server should start when ZipSight is launched. This will use the
  62. current configuration settings for server path and port number so before
  63. setting this option make sure the server path is not pointing to some
  64. folder you do not wish to make visible on the network! If the server
  65. path is not specified in the zipsight.properties file, the path 
  66. defaults to the java user.dir property. Usually, this will be the folder
  67. where ZipSight resides.
  68.  
  69. The check box marked "Do not allow remote connections" determines
  70. whether or not ZipSight will allow connections from remote machines.
  71. If this check box is set, ZipSight will only allow connections originating
  72. from the local machine.
  73.  
  74.  
  75. Instructions
  76. ------------
  77. On pressing the start button the server will begin listening for a
  78. connection on the port number specified in the configuration panel. The 
  79. status field should change from "stopped" to "running". The server address 
  80. field should show the machine's HTTP address. This field is not editable, 
  81. but it appears to let the user know what the server's address is. The text 
  82. from this field can be copied and pasted into a WWW-browser to specify 
  83. the correct URL.
  84.  
  85. Once the server is started, it is ready to begin serving http requests.
  86. Fire up your favorite WWW browser and enter the URL for the file(s) you
  87. wish to browse.
  88.  
  89. URLs to the server should be constructed as follows:
  90.  
  91. * to specify files within a zip:
  92.  
  93.   http://IP:PORT/path1/filename.zip/path2/filename.html
  94.  
  95.   IP:PORT is the address where the server is listening (displayed in the 
  96.   "Server address" field). 
  97.   
  98.   "path1" is the path to the file "filename.zip". This path will be 
  99.   appended to the server path by ZipSight in order to locate the file
  100.   "filename.zip". It is, of course, optional.
  101.   
  102.   "filename.zip" is the name of the zip/jar file being served.
  103.   
  104.   "path2" is the path inside the zip/jar file used to find the html
  105.   document "filename.html".
  106.  
  107. * to specify files outside a zip:
  108.  
  109.   http://IP:PORT/path/filename.html
  110.  
  111. * If a filename is not specified, ZipSight will search for a default 
  112.   index inside the zip file (index.html). Thus, the following URL will 
  113.   display the file "index.html" located inside filename.zip.
  114.  
  115.   http://IP:PORT/filename.zip/
  116.  
  117.   If there is no "index.html" file within the zip file, ZipSight will 
  118.   generate an index of the contents of the zip file, with hyper links to 
  119.   all html files it finds inside the zip.
  120.   
  121. ========================================================================
  122. New Features in This Version
  123. ========================================================================
  124. 1.2
  125. * Added an option to disallow remote connections.
  126.  
  127. * Updated to Swing 1.1b3
  128.  
  129. 1.1
  130. * Added pref to autostart the server on launch.
  131.  
  132. * This version of ZipSight requires Swing version 1.0.3 or later. Make sure
  133.   the swing libraries reside in the Java VM's classpath before running the
  134.   application.
  135.   
  136. * ZipSight now saves the configuration options to disk in a file called
  137.   "zipsight.properties" so they can be remembered between sessions.
  138.   Currently, it saves only the following properties: screen position,
  139.   server port number, server home, whether logging should be enabled, and
  140.   whether or not the server should start as soon as ZipSight is launched.
  141.   The properties file is a text file so it can be edited by the user.
  142.   
  143. 1.0
  144. * N/A
  145.  
  146. ========================================================================
  147. Bugs Fixed in This Version
  148. ========================================================================
  149. * 1.2b2 Fixed a bug where the internal server path was being corrupted
  150.   after changing it in the ZipSight config panel.
  151.  
  152. * 1.1b3 On Mac, it was not possible to copy the server address from the 
  153.   text field using cmd-C. Menu items have been added which enable the user
  154.   to select and copy this text. To do this, use "Edit->Select" and/or
  155.   "Edit->Copy". 
  156.  
  157. ========================================================================
  158. Known Bugs and Incompatibilities
  159.  
  160. ========================================================================
  161.  
  162. * none.
  163.  
  164. ========================================================================
  165. Additional Notes
  166. ========================================================================
  167.  
  168. * As mentioned above, this application requires a 1.1 or greater VM. On
  169.   the Mac, you should use MRJ 2.1 or later.  On windows, JDK/JRE
  170.   version 1.2 is recommended although it has been tested on JDK 1.1.6
  171.   and later.
  172.  
  173. ========================================================================
  174. Contacting Metrowerks
  175. ========================================================================
  176.  
  177. For bug reports, technical questions, and suggestions, please use the
  178. forms in the Release Notes folder on the CD, and send them to
  179.  
  180. support@metrowerks.com
  181.  
  182. See the CodeWarrior on the Nets document in the Release Notes folder for
  183. more contact information, including a list of Internet news groups, 
  184. on-line services, and patch and update sites.
  185.  
  186. ========================================================================
  187.  
  188. CodeWarrior Java Engineers
  189. Metrowerks Corporation